This repository was archived by the owner on Jan 19, 2026. It is now read-only.
chore: internal docs for beta#187
Merged
Merged
Conversation
- Updated the main README to indicate that official documentation for package v4 is not yet available, directing users to the internal documentation for the v4 beta. - Created a new README file in the src directory to provide detailed installation instructions and command references for the Storyblok CLI package. - Added a comprehensive guide for the `login` command, including usage examples and options.
- Created a new README file for the `logout` command, detailing its usage, functionality, and examples. - Included information on credential removal, session clearing, and warnings for already logged-out users. - Aimed to enhance user understanding and provide clear instructions for the logout process.
- Created a new README file for the `languages` command, detailing its usage, options, and examples for pulling language configurations from a Storyblok space. - Included information on file structure and notes for user requirements, enhancing clarity and usability for developers interacting with the command.
- Created a new README file for the `user` command, detailing its usage, functionality, and examples for viewing user information in Storyblok. - Updated the main README to include a reference to the new `user` command, enhancing clarity and usability for developers interacting with the CLI. - Aimed to provide comprehensive guidance for users to understand and utilize the command effectively.
- Updated the Command Reference section in the README to improve clarity and organization. - Added a new Global Options section detailing options available for all commands, including descriptions and default values. - Included a tip for users on providing verbose output when reporting bugs or support tickets to enhance troubleshooting.
- Removed unnecessary trailing whitespace from the README files for the `languages`, `login`, and `user` commands to improve formatting and maintain consistency across documentation. - Ensured that all files end with a newline for better compatibility with various text editors.
… options - Created detailed README files for the `components pull` and `components push` commands, outlining their usage, options, and examples for managing Storyblok components. - Updated the main README to reference the new `components` module and its subcommands, enhancing clarity for developers. - Adjusted option descriptions for consistency, including the removal of default values where applicable.
- Cleaned up the README files for the `components`, `components pull`, and `components push` commands by removing unnecessary trailing whitespace to improve formatting and maintain consistency across documentation. - Ensured all files end with a newline for better compatibility with various text editors.
- Created detailed README files for the `migrations`, `migrations generate`, and `migrations rollback` commands, outlining their usage, options, and examples for managing Storyblok component migrations. - Updated the `migrations run` command documentation to include new options for publication modes and improved examples for clarity. - Enhanced overall documentation structure to provide comprehensive guidance for developers interacting with the migrations functionality.
commit: |
| > [!WARNING] | ||
| > Official documentation about this package v4 is not yet available. Please refer to the internal documentation for the [v4 beta](src/README.md). | ||
|
|
||
| ~~For complete documentation, please visit [https://storyblok.com/docs](https://storyblok.com/docs/packages/my-joyful-package)~~ |
Contributor
There was a problem hiding this comment.
I would comment this out until we have the actual documentation link.
Comment on lines
+7
to
+17
| For the latest beta version, install the package using the following command: | ||
|
|
||
| ```bash | ||
| npm install storyblok@beta | ||
| ``` | ||
|
|
||
| Or for an specific beta version: | ||
|
|
||
| ```bash | ||
| npm install storyblok@4.0.0-beta.<version> | ||
| ``` |
Contributor
There was a problem hiding this comment.
My suggestion is to keep the non-beta installation command in here. It makes sense for people to want the stable version for a new project.
Suggested change
| For the latest beta version, install the package using the following command: | |
| ```bash | |
| npm install storyblok@beta | |
| ``` | |
| Or for an specific beta version: | |
| ```bash | |
| npm install storyblok@4.0.0-beta.<version> | |
| ``` | |
| Add the package to your project with the following command: | |
| ```bash | |
| npm install storyblok@latest |
You can also install the beta version, currently in development:
npm install storyblok@betaIt's also possible to target a specific beta version:
npm install storyblok@4.0.0-beta.<version>
There was a problem hiding this comment.
Hey @alvarosabu, is this readme going to be in main, or in a beta branch? If it's supposed to be in main, I agree with @jeremenichelli.
Contributor
Author
There was a problem hiding this comment.
No, it's going to live on the next branch @manuelschroederdev @jeremenichelli these documentations are strictly for the beta since they will be replaced by official documentation later on
There was a problem hiding this comment.
That's what I thought. 😄 Then feel free to disregard the suggestion from Jeremias here.
| @@ -0,0 +1,100 @@ | |||
| # Languages Command | |||
|
|
|||
| The `languages` command allows you to manage languages in your Storyblok space. Currently, it supports pulling language configurations from your space. | |||
Contributor
There was a problem hiding this comment.
Suggested change
| The `languages` command allows you to manage languages in your Storyblok space. Currently, it supports pulling language configurations from your space. | |
| The `languages` command allows you to handle internalization features within your Storyblok space. Currently, it supports pulling language configurations from your space. |
There was a problem hiding this comment.
Hey @jeremenichelli @alvarosabu, I think both versions are a bit too bold. As it doesn't allow for managing anything at this point, we shouldn't raise any unrealistic expectations. If I'm not mistaken, this currently allows you to retrieve all configured languages as a JSON, similar to the spaces/me endpoint, correct?
Contributor
Author
There was a problem hiding this comment.
Correct, it only allows pulling the languages available on the space @manuelschroederdev
There was a problem hiding this comment.
Are there any plans to expand the functionality in the future?
Co-authored-by: Jeremias Menichelli <jmenichelli@gmail.com>
- Removed outdated documentation reference from the main README. - Renamed the "Command Reference" section to "API" in the src README for better alignment with content. - Enhanced the API section by adding a status legend to clarify the readiness of commands. - Updated the description of the `languages` command to specify its functionality more accurately. These changes aim to improve the overall documentation quality and user experience for developers interacting with the Storyblok CLI.
- Eliminated an extra blank line in the main README to improve formatting and maintain consistency across documentation. This minor adjustment enhances readability for developers.
- Eliminated the note stating "You must be logged in to use this command" from the README files of various commands, including `pull`, `push`, `languages`, `migrations`, and `user`. This change aims to streamline the documentation and reduce redundancy, as the login requirement is already implied in the context of command usage.
edodusi
approved these changes
May 9, 2025
Contributor
edodusi
left a comment
edodusi
left a comment
There was a problem hiding this comment.
@alvarosabu I don't have much to add here, to me the README are fine and I more or less have tested all the commands
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the temporary documentation for the Storyblok CLI v4 beta. Eventually, this will be moved to the official documentation